3 * Local file in the wiki's own database.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup FileAbstraction
24 use MediaWiki\Logger\LoggerFactory
;
25 use Wikimedia\Rdbms\Database
;
26 use Wikimedia\Rdbms\IDatabase
;
29 * Class to represent a local file in the wiki's own database
31 * Provides methods to retrieve paths (physical, logical, URL),
32 * to generate image thumbnails or for uploading.
34 * Note that only the repo object knows what its file class is called. You should
35 * never name a file class explictly outside of the repo class. Instead use the
36 * repo's factory functions to generate file objects, for example:
38 * RepoGroup::singleton()->getLocalRepo()->newFile( $title );
40 * The convenience functions wfLocalFile() and wfFindFile() should be sufficient
43 * @ingroup FileAbstraction
45 class LocalFile
extends File
{
46 const VERSION
= 10; // cache version
48 const CACHE_FIELD_MAX_LEN
= 1000;
50 /** @var bool Does the file exist on disk? (loadFromXxx) */
51 protected $fileExists;
53 /** @var int Image width */
56 /** @var int Image height */
59 /** @var int Returned by getimagesize (loadFromXxx) */
62 /** @var string MEDIATYPE_xxx (bitmap, drawing, audio...) */
63 protected $media_type;
65 /** @var string MIME type, determined by MimeMagic::guessMimeType */
68 /** @var int Size in bytes (loadFromXxx) */
71 /** @var string Handler-specific metadata */
74 /** @var string SHA-1 base 36 content hash */
77 /** @var bool Whether or not core data has been loaded from the database (loadFromXxx) */
78 protected $dataLoaded;
80 /** @var bool Whether or not lazy-loaded data has been loaded from the database */
81 protected $extraDataLoaded;
83 /** @var int Bitfield akin to rev_deleted */
87 protected $repoClass = 'LocalRepo';
89 /** @var int Number of line to return by nextHistoryLine() (constructor) */
92 /** @var int Result of the query for the file's history (nextHistoryLine) */
95 /** @var string Major MIME type */
98 /** @var string Minor MIME type */
101 /** @var string Upload timestamp */
104 /** @var int User ID of uploader */
107 /** @var string User name of uploader */
110 /** @var string Description of current revision of the file */
111 private $description;
113 /** @var string TS_MW timestamp of the last change of the file description */
114 private $descriptionTouched;
116 /** @var bool Whether the row was upgraded on load */
119 /** @var bool Whether the row was scheduled to upgrade on load */
122 /** @var bool True if the image row is locked */
125 /** @var bool True if the image row is locked with a lock initiated transaction */
126 private $lockedOwnTrx;
128 /** @var bool True if file is not present in file system. Not to be cached in memcached */
131 // @note: higher than IDBAccessObject constants
132 const LOAD_ALL
= 16; // integer; load all the lazy fields too (like metadata)
134 const ATOMIC_SECTION_LOCK
= 'LocalFile::lockingTransaction';
137 * Create a LocalFile from a title
138 * Do not call this except from inside a repo class.
140 * Note: $unused param is only here to avoid an E_STRICT
142 * @param Title $title
143 * @param FileRepo $repo
144 * @param null $unused
148 static function newFromTitle( $title, $repo, $unused = null ) {
149 return new self( $title, $repo );
153 * Create a LocalFile from a title
154 * Do not call this except from inside a repo class.
156 * @param stdClass $row
157 * @param FileRepo $repo
161 static function newFromRow( $row, $repo ) {
162 $title = Title
::makeTitle( NS_FILE
, $row->img_name
);
163 $file = new self( $title, $repo );
164 $file->loadFromRow( $row );
170 * Create a LocalFile from a SHA-1 key
171 * Do not call this except from inside a repo class.
173 * @param string $sha1 Base-36 SHA-1
174 * @param LocalRepo $repo
175 * @param string|bool $timestamp MW_timestamp (optional)
176 * @return bool|LocalFile
178 static function newFromKey( $sha1, $repo, $timestamp = false ) {
179 $dbr = $repo->getReplicaDB();
181 $conds = [ 'img_sha1' => $sha1 ];
183 $conds['img_timestamp'] = $dbr->timestamp( $timestamp );
186 $row = $dbr->selectRow( 'image', self
::selectFields(), $conds, __METHOD__
);
188 return self
::newFromRow( $row, $repo );
195 * Fields in the image table
198 static function selectFields() {
219 * Do not call this except from inside a repo class.
220 * @param Title $title
221 * @param FileRepo $repo
223 function __construct( $title, $repo ) {
224 parent
::__construct( $title, $repo );
226 $this->metadata
= '';
227 $this->historyLine
= 0;
228 $this->historyRes
= null;
229 $this->dataLoaded
= false;
230 $this->extraDataLoaded
= false;
232 $this->assertRepoDefined();
233 $this->assertTitleDefined();
237 * Get the memcached key for the main data for this file, or false if
238 * there is no access to the shared cache.
239 * @return string|bool
241 function getCacheKey() {
242 return $this->repo
->getSharedCacheKey( 'file', sha1( $this->getName() ) );
246 * @param WANObjectCache $cache
250 public function getMutableCacheKeys( WANObjectCache
$cache ) {
251 return [ $this->getCacheKey() ];
255 * Try to load file metadata from memcached, falling back to the database
257 private function loadFromCache() {
258 $this->dataLoaded
= false;
259 $this->extraDataLoaded
= false;
261 $key = $this->getCacheKey();
263 $this->loadFromDB( self
::READ_NORMAL
);
268 $cache = ObjectCache
::getMainWANInstance();
269 $cachedValues = $cache->getWithSetCallback(
272 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
273 $setOpts +
= Database
::getCacheSetOptions( $this->repo
->getReplicaDB() );
275 $this->loadFromDB( self
::READ_NORMAL
);
277 $fields = $this->getCacheFields( '' );
278 $cacheVal['fileExists'] = $this->fileExists
;
279 if ( $this->fileExists
) {
280 foreach ( $fields as $field ) {
281 $cacheVal[$field] = $this->$field;
284 // Strip off excessive entries from the subset of fields that can become large.
285 // If the cache value gets to large it will not fit in memcached and nothing will
286 // get cached at all, causing master queries for any file access.
287 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
288 if ( isset( $cacheVal[$field] )
289 && strlen( $cacheVal[$field] ) > 100 * 1024
291 unset( $cacheVal[$field] ); // don't let the value get too big
295 if ( $this->fileExists
) {
296 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX
, $this->timestamp
), $ttl );
298 $ttl = $cache::TTL_DAY
;
303 [ 'version' => self
::VERSION
]
306 $this->fileExists
= $cachedValues['fileExists'];
307 if ( $this->fileExists
) {
308 $this->setProps( $cachedValues );
311 $this->dataLoaded
= true;
312 $this->extraDataLoaded
= true;
313 foreach ( $this->getLazyCacheFields( '' ) as $field ) {
314 $this->extraDataLoaded
= $this->extraDataLoaded
&& isset( $cachedValues[$field] );
319 * Purge the file object/metadata cache
321 public function invalidateCache() {
322 $key = $this->getCacheKey();
327 $this->repo
->getMasterDB()->onTransactionPreCommitOrIdle(
328 function () use ( $key ) {
329 ObjectCache
::getMainWANInstance()->delete( $key );
336 * Load metadata from the file itself
338 function loadFromFile() {
339 $props = $this->repo
->getFileProps( $this->getVirtualUrl() );
340 $this->setProps( $props );
344 * @param string $prefix
347 function getCacheFields( $prefix = 'img_' ) {
348 static $fields = [ 'size', 'width', 'height', 'bits', 'media_type',
349 'major_mime', 'minor_mime', 'metadata', 'timestamp', 'sha1', 'user',
350 'user_text', 'description' ];
351 static $results = [];
353 if ( $prefix == '' ) {
357 if ( !isset( $results[$prefix] ) ) {
358 $prefixedFields = [];
359 foreach ( $fields as $field ) {
360 $prefixedFields[] = $prefix . $field;
362 $results[$prefix] = $prefixedFields;
365 return $results[$prefix];
369 * @param string $prefix
372 function getLazyCacheFields( $prefix = 'img_' ) {
373 static $fields = [ 'metadata' ];
374 static $results = [];
376 if ( $prefix == '' ) {
380 if ( !isset( $results[$prefix] ) ) {
381 $prefixedFields = [];
382 foreach ( $fields as $field ) {
383 $prefixedFields[] = $prefix . $field;
385 $results[$prefix] = $prefixedFields;
388 return $results[$prefix];
392 * Load file metadata from the DB
395 function loadFromDB( $flags = 0 ) {
396 $fname = static::class . '::' . __FUNCTION__
;
398 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
399 $this->dataLoaded
= true;
400 $this->extraDataLoaded
= true;
402 $dbr = ( $flags & self
::READ_LATEST
)
403 ?
$this->repo
->getMasterDB()
404 : $this->repo
->getReplicaDB();
406 $row = $dbr->selectRow( 'image', $this->getCacheFields( 'img_' ),
407 [ 'img_name' => $this->getName() ], $fname );
410 $this->loadFromRow( $row );
412 $this->fileExists
= false;
417 * Load lazy file metadata from the DB.
418 * This covers fields that are sometimes not cached.
420 protected function loadExtraFromDB() {
421 $fname = static::class . '::' . __FUNCTION__
;
423 # Unconditionally set loaded=true, we don't want the accessors constantly rechecking
424 $this->extraDataLoaded
= true;
426 $fieldMap = $this->loadFieldsWithTimestamp( $this->repo
->getReplicaDB(), $fname );
428 $fieldMap = $this->loadFieldsWithTimestamp( $this->repo
->getMasterDB(), $fname );
432 foreach ( $fieldMap as $name => $value ) {
433 $this->$name = $value;
436 throw new MWException( "Could not find data for image '{$this->getName()}'." );
441 * @param IDatabase $dbr
442 * @param string $fname
445 private function loadFieldsWithTimestamp( $dbr, $fname ) {
448 $row = $dbr->selectRow( 'image', $this->getLazyCacheFields( 'img_' ), [
449 'img_name' => $this->getName(),
450 'img_timestamp' => $dbr->timestamp( $this->getTimestamp() )
453 $fieldMap = $this->unprefixRow( $row, 'img_' );
455 # File may have been uploaded over in the meantime; check the old versions
456 $row = $dbr->selectRow( 'oldimage', $this->getLazyCacheFields( 'oi_' ), [
457 'oi_name' => $this->getName(),
458 'oi_timestamp' => $dbr->timestamp( $this->getTimestamp() )
461 $fieldMap = $this->unprefixRow( $row, 'oi_' );
469 * @param array|object $row
470 * @param string $prefix
471 * @throws MWException
474 protected function unprefixRow( $row, $prefix = 'img_' ) {
475 $array = (array)$row;
476 $prefixLength = strlen( $prefix );
478 // Sanity check prefix once
479 if ( substr( key( $array ), 0, $prefixLength ) !== $prefix ) {
480 throw new MWException( __METHOD__
. ': incorrect $prefix parameter' );
484 foreach ( $array as $name => $value ) {
485 $decoded[substr( $name, $prefixLength )] = $value;
492 * Decode a row from the database (either object or array) to an array
493 * with timestamps and MIME types decoded, and the field prefix removed.
495 * @param string $prefix
496 * @throws MWException
499 function decodeRow( $row, $prefix = 'img_' ) {
500 $decoded = $this->unprefixRow( $row, $prefix );
502 $decoded['timestamp'] = wfTimestamp( TS_MW
, $decoded['timestamp'] );
504 $decoded['metadata'] = $this->repo
->getReplicaDB()->decodeBlob( $decoded['metadata'] );
506 if ( empty( $decoded['major_mime'] ) ) {
507 $decoded['mime'] = 'unknown/unknown';
509 if ( !$decoded['minor_mime'] ) {
510 $decoded['minor_mime'] = 'unknown';
512 $decoded['mime'] = $decoded['major_mime'] . '/' . $decoded['minor_mime'];
515 // Trim zero padding from char/binary field
516 $decoded['sha1'] = rtrim( $decoded['sha1'], "\0" );
518 // Normalize some fields to integer type, per their database definition.
519 // Use unary + so that overflows will be upgraded to double instead of
520 // being trucated as with intval(). This is important to allow >2GB
521 // files on 32-bit systems.
522 foreach ( [ 'size', 'width', 'height', 'bits' ] as $field ) {
523 $decoded[$field] = +
$decoded[$field];
530 * Load file metadata from a DB result row
533 * @param string $prefix
535 function loadFromRow( $row, $prefix = 'img_' ) {
536 $this->dataLoaded
= true;
537 $this->extraDataLoaded
= true;
539 $array = $this->decodeRow( $row, $prefix );
541 foreach ( $array as $name => $value ) {
542 $this->$name = $value;
545 $this->fileExists
= true;
546 $this->maybeUpgradeRow();
550 * Load file metadata from cache or DB, unless already loaded
553 function load( $flags = 0 ) {
554 if ( !$this->dataLoaded
) {
555 if ( $flags & self
::READ_LATEST
) {
556 $this->loadFromDB( $flags );
558 $this->loadFromCache();
562 if ( ( $flags & self
::LOAD_ALL
) && !$this->extraDataLoaded
) {
563 // @note: loads on name/timestamp to reduce race condition problems
564 $this->loadExtraFromDB();
569 * Upgrade a row if it needs it
571 function maybeUpgradeRow() {
572 global $wgUpdateCompatibleMetadata;
574 if ( wfReadOnly() ||
$this->upgrading
) {
579 if ( is_null( $this->media_type
) ||
$this->mime
== 'image/svg' ) {
582 $handler = $this->getHandler();
584 $validity = $handler->isMetadataValid( $this, $this->getMetadata() );
585 if ( $validity === MediaHandler
::METADATA_BAD
) {
587 } elseif ( $validity === MediaHandler
::METADATA_COMPATIBLE
) {
588 $upgrade = $wgUpdateCompatibleMetadata;
594 $this->upgrading
= true;
595 // Defer updates unless in auto-commit CLI mode
596 DeferredUpdates
::addCallableUpdate( function() {
597 $this->upgrading
= false; // avoid duplicate updates
600 } catch ( LocalFileLockError
$e ) {
601 // let the other process handle it (or do it next time)
608 * @return bool Whether upgradeRow() ran for this object
610 function getUpgraded() {
611 return $this->upgraded
;
615 * Fix assorted version-related problems with the image row by reloading it from the file
617 function upgradeRow() {
618 $this->lock(); // begin
620 $this->loadFromFile();
622 # Don't destroy file info of missing files
623 if ( !$this->fileExists
) {
625 wfDebug( __METHOD__
. ": file does not exist, aborting\n" );
630 $dbw = $this->repo
->getMasterDB();
631 list( $major, $minor ) = self
::splitMime( $this->mime
);
633 if ( wfReadOnly() ) {
638 wfDebug( __METHOD__
. ': upgrading ' . $this->getName() . " to the current schema\n" );
640 $dbw->update( 'image',
642 'img_size' => $this->size
, // sanity
643 'img_width' => $this->width
,
644 'img_height' => $this->height
,
645 'img_bits' => $this->bits
,
646 'img_media_type' => $this->media_type
,
647 'img_major_mime' => $major,
648 'img_minor_mime' => $minor,
649 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
650 'img_sha1' => $this->sha1
,
652 [ 'img_name' => $this->getName() ],
656 $this->invalidateCache();
658 $this->unlock(); // done
659 $this->upgraded
= true; // avoid rework/retries
663 * Set properties in this object to be equal to those given in the
664 * associative array $info. Only cacheable fields can be set.
665 * All fields *must* be set in $info except for getLazyCacheFields().
667 * If 'mime' is given, it will be split into major_mime/minor_mime.
668 * If major_mime/minor_mime are given, $this->mime will also be set.
672 function setProps( $info ) {
673 $this->dataLoaded
= true;
674 $fields = $this->getCacheFields( '' );
675 $fields[] = 'fileExists';
677 foreach ( $fields as $field ) {
678 if ( isset( $info[$field] ) ) {
679 $this->$field = $info[$field];
683 // Fix up mime fields
684 if ( isset( $info['major_mime'] ) ) {
685 $this->mime
= "{$info['major_mime']}/{$info['minor_mime']}";
686 } elseif ( isset( $info['mime'] ) ) {
687 $this->mime
= $info['mime'];
688 list( $this->major_mime
, $this->minor_mime
) = self
::splitMime( $this->mime
);
692 /** splitMime inherited */
693 /** getName inherited */
694 /** getTitle inherited */
695 /** getURL inherited */
696 /** getViewURL inherited */
697 /** getPath inherited */
698 /** isVisible inherited */
703 function isMissing() {
704 if ( $this->missing
=== null ) {
705 list( $fileExists ) = $this->repo
->fileExists( $this->getVirtualUrl() );
706 $this->missing
= !$fileExists;
709 return $this->missing
;
713 * Return the width of the image
718 public function getWidth( $page = 1 ) {
721 if ( $this->isMultipage() ) {
722 $handler = $this->getHandler();
726 $dim = $handler->getPageDimensions( $this, $page );
728 return $dim['width'];
730 // For non-paged media, the false goes through an
731 // intval, turning failure into 0, so do same here.
740 * Return the height of the image
745 public function getHeight( $page = 1 ) {
748 if ( $this->isMultipage() ) {
749 $handler = $this->getHandler();
753 $dim = $handler->getPageDimensions( $this, $page );
755 return $dim['height'];
757 // For non-paged media, the false goes through an
758 // intval, turning failure into 0, so do same here.
762 return $this->height
;
767 * Returns ID or name of user who uploaded the file
769 * @param string $type 'text' or 'id'
772 function getUser( $type = 'text' ) {
775 if ( $type == 'text' ) {
776 return $this->user_text
;
778 return (int)$this->user
;
783 * Get short description URL for a file based on the page ID.
785 * @return string|null
786 * @throws MWException
789 public function getDescriptionShortUrl() {
790 $pageId = $this->title
->getArticleID();
792 if ( $pageId !== null ) {
793 $url = $this->repo
->makeUrl( [ 'curid' => $pageId ] );
794 if ( $url !== false ) {
802 * Get handler-specific metadata
805 function getMetadata() {
806 $this->load( self
::LOAD_ALL
); // large metadata is loaded in another step
807 return $this->metadata
;
813 function getBitDepth() {
816 return (int)$this->bits
;
820 * Returns the size of the image file, in bytes
823 public function getSize() {
830 * Returns the MIME type of the file.
833 function getMimeType() {
840 * Returns the type of the media in the file.
841 * Use the value returned by this function with the MEDIATYPE_xxx constants.
844 function getMediaType() {
847 return $this->media_type
;
850 /** canRender inherited */
851 /** mustRender inherited */
852 /** allowInlineDisplay inherited */
853 /** isSafeFile inherited */
854 /** isTrustedFile inherited */
857 * Returns true if the file exists on disk.
858 * @return bool Whether file exist on disk.
860 public function exists() {
863 return $this->fileExists
;
866 /** getTransformScript inherited */
867 /** getUnscaledThumb inherited */
868 /** thumbName inherited */
869 /** createThumb inherited */
870 /** transform inherited */
872 /** getHandler inherited */
873 /** iconThumb inherited */
874 /** getLastError inherited */
877 * Get all thumbnail names previously generated for this file
878 * @param string|bool $archiveName Name of an archive file, default false
879 * @return array First element is the base dir, then files in that base dir.
881 function getThumbnails( $archiveName = false ) {
882 if ( $archiveName ) {
883 $dir = $this->getArchiveThumbPath( $archiveName );
885 $dir = $this->getThumbPath();
888 $backend = $this->repo
->getBackend();
891 $iterator = $backend->getFileList( [ 'dir' => $dir ] );
892 foreach ( $iterator as $file ) {
895 } catch ( FileBackendError
$e ) {
896 } // suppress (T56674)
902 * Refresh metadata in memcached, but don't touch thumbnails or CDN
904 function purgeMetadataCache() {
905 $this->invalidateCache();
909 * Delete all previously generated thumbnails, refresh metadata in memcached and purge the CDN.
911 * @param array $options An array potentially with the key forThumbRefresh.
913 * @note This used to purge old thumbnails by default as well, but doesn't anymore.
915 function purgeCache( $options = [] ) {
916 // Refresh metadata cache
917 $this->purgeMetadataCache();
920 $this->purgeThumbnails( $options );
922 // Purge CDN cache for this file
923 DeferredUpdates
::addUpdate(
924 new CdnCacheUpdate( [ $this->getUrl() ] ),
925 DeferredUpdates
::PRESEND
930 * Delete cached transformed files for an archived version only.
931 * @param string $archiveName Name of the archived file
933 function purgeOldThumbnails( $archiveName ) {
934 // Get a list of old thumbnails and URLs
935 $files = $this->getThumbnails( $archiveName );
937 // Purge any custom thumbnail caches
938 Hooks
::run( 'LocalFilePurgeThumbnails', [ $this, $archiveName ] );
941 $dir = array_shift( $files );
942 $this->purgeThumbList( $dir, $files );
946 foreach ( $files as $file ) {
947 $urls[] = $this->getArchiveThumbUrl( $archiveName, $file );
949 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates
::PRESEND
);
953 * Delete cached transformed files for the current version only.
954 * @param array $options
956 public function purgeThumbnails( $options = [] ) {
957 $files = $this->getThumbnails();
958 // Always purge all files from CDN regardless of handler filters
960 foreach ( $files as $file ) {
961 $urls[] = $this->getThumbUrl( $file );
963 array_shift( $urls ); // don't purge directory
965 // Give media handler a chance to filter the file purge list
966 if ( !empty( $options['forThumbRefresh'] ) ) {
967 $handler = $this->getHandler();
969 $handler->filterThumbnailPurgeList( $files, $options );
973 // Purge any custom thumbnail caches
974 Hooks
::run( 'LocalFilePurgeThumbnails', [ $this, false ] );
977 $dir = array_shift( $files );
978 $this->purgeThumbList( $dir, $files );
981 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $urls ), DeferredUpdates
::PRESEND
);
985 * Prerenders a configurable set of thumbnails
989 public function prerenderThumbnails() {
990 global $wgUploadThumbnailRenderMap;
994 $sizes = $wgUploadThumbnailRenderMap;
997 foreach ( $sizes as $size ) {
998 if ( $this->isVectorized() ||
$this->getWidth() > $size ) {
999 $jobs[] = new ThumbnailRenderJob(
1001 [ 'transformParams' => [ 'width' => $size ] ]
1007 JobQueueGroup
::singleton()->lazyPush( $jobs );
1012 * Delete a list of thumbnails visible at urls
1013 * @param string $dir Base dir of the files.
1014 * @param array $files Array of strings: relative filenames (to $dir)
1016 protected function purgeThumbList( $dir, $files ) {
1017 $fileListDebug = strtr(
1018 var_export( $files, true ),
1021 wfDebug( __METHOD__
. ": $fileListDebug\n" );
1024 foreach ( $files as $file ) {
1025 # Check that the base file name is part of the thumb name
1026 # This is a basic sanity check to avoid erasing unrelated directories
1027 if ( strpos( $file, $this->getName() ) !== false
1028 ||
strpos( $file, "-thumbnail" ) !== false // "short" thumb name
1030 $purgeList[] = "{$dir}/{$file}";
1034 # Delete the thumbnails
1035 $this->repo
->quickPurgeBatch( $purgeList );
1036 # Clear out the thumbnail directory if empty
1037 $this->repo
->quickCleanDir( $dir );
1040 /** purgeDescription inherited */
1041 /** purgeEverything inherited */
1044 * @param int $limit Optional: Limit to number of results
1045 * @param int $start Optional: Timestamp, start from
1046 * @param int $end Optional: Timestamp, end at
1048 * @return OldLocalFile[]
1050 function getHistory( $limit = null, $start = null, $end = null, $inc = true ) {
1051 $dbr = $this->repo
->getReplicaDB();
1052 $tables = [ 'oldimage' ];
1053 $fields = OldLocalFile
::selectFields();
1054 $conds = $opts = $join_conds = [];
1055 $eq = $inc ?
'=' : '';
1056 $conds[] = "oi_name = " . $dbr->addQuotes( $this->title
->getDBkey() );
1059 $conds[] = "oi_timestamp <$eq " . $dbr->addQuotes( $dbr->timestamp( $start ) );
1063 $conds[] = "oi_timestamp >$eq " . $dbr->addQuotes( $dbr->timestamp( $end ) );
1067 $opts['LIMIT'] = $limit;
1070 // Search backwards for time > x queries
1071 $order = ( !$start && $end !== null ) ?
'ASC' : 'DESC';
1072 $opts['ORDER BY'] = "oi_timestamp $order";
1073 $opts['USE INDEX'] = [ 'oldimage' => 'oi_name_timestamp' ];
1075 // Avoid PHP 7.1 warning from passing $this by reference
1077 Hooks
::run( 'LocalFile::getHistory', [ &$localFile, &$tables, &$fields,
1078 &$conds, &$opts, &$join_conds ] );
1080 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $opts, $join_conds );
1083 foreach ( $res as $row ) {
1084 $r[] = $this->repo
->newFileFromRow( $row );
1087 if ( $order == 'ASC' ) {
1088 $r = array_reverse( $r ); // make sure it ends up descending
1095 * Returns the history of this file, line by line.
1096 * starts with current version, then old versions.
1097 * uses $this->historyLine to check which line to return:
1098 * 0 return line for current version
1099 * 1 query for old versions, return first one
1100 * 2, ... return next old version from above query
1103 public function nextHistoryLine() {
1104 # Polymorphic function name to distinguish foreign and local fetches
1105 $fname = static::class . '::' . __FUNCTION__
;
1107 $dbr = $this->repo
->getReplicaDB();
1109 if ( $this->historyLine
== 0 ) { // called for the first time, return line from cur
1110 $this->historyRes
= $dbr->select( 'image',
1113 "'' AS oi_archive_name",
1117 [ 'img_name' => $this->title
->getDBkey() ],
1121 if ( 0 == $dbr->numRows( $this->historyRes
) ) {
1122 $this->historyRes
= null;
1126 } elseif ( $this->historyLine
== 1 ) {
1127 $this->historyRes
= $dbr->select( 'oldimage', '*',
1128 [ 'oi_name' => $this->title
->getDBkey() ],
1130 [ 'ORDER BY' => 'oi_timestamp DESC' ]
1133 $this->historyLine++
;
1135 return $dbr->fetchObject( $this->historyRes
);
1139 * Reset the history pointer to the first element of the history
1141 public function resetHistory() {
1142 $this->historyLine
= 0;
1144 if ( !is_null( $this->historyRes
) ) {
1145 $this->historyRes
= null;
1149 /** getHashPath inherited */
1150 /** getRel inherited */
1151 /** getUrlRel inherited */
1152 /** getArchiveRel inherited */
1153 /** getArchivePath inherited */
1154 /** getThumbPath inherited */
1155 /** getArchiveUrl inherited */
1156 /** getThumbUrl inherited */
1157 /** getArchiveVirtualUrl inherited */
1158 /** getThumbVirtualUrl inherited */
1159 /** isHashed inherited */
1162 * Upload a file and record it in the DB
1163 * @param string|FSFile $src Source storage path, virtual URL, or filesystem path
1164 * @param string $comment Upload description
1165 * @param string $pageText Text to use for the new description page,
1166 * if a new description page is created
1167 * @param int|bool $flags Flags for publish()
1168 * @param array|bool $props File properties, if known. This can be used to
1169 * reduce the upload time when uploading virtual URLs for which the file
1170 * info is already known
1171 * @param string|bool $timestamp Timestamp for img_timestamp, or false to use the
1173 * @param User|null $user User object or null to use $wgUser
1174 * @param string[] $tags Change tags to add to the log entry and page revision.
1175 * (This doesn't check $user's permissions.)
1176 * @return Status On success, the value member contains the
1177 * archive name, or an empty string if it was a new file.
1179 function upload( $src, $comment, $pageText, $flags = 0, $props = false,
1180 $timestamp = false, $user = null, $tags = []
1184 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1185 return $this->readOnlyFatalStatus();
1188 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1190 if ( $this->repo
->isVirtualUrl( $srcPath )
1191 || FileBackend
::isStoragePath( $srcPath )
1193 $props = $this->repo
->getFileProps( $srcPath );
1195 $mwProps = new MWFileProps( MimeMagic
::singleton() );
1196 $props = $mwProps->getPropsFromPath( $srcPath, true );
1201 $handler = MediaHandler
::getHandler( $props['mime'] );
1203 $options['headers'] = $handler->getStreamHeaders( $props['metadata'] );
1205 $options['headers'] = [];
1208 // Trim spaces on user supplied text
1209 $comment = trim( $comment );
1211 // Truncate nicely or the DB will do it for us
1212 // non-nicely (dangling multi-byte chars, non-truncated version in cache).
1213 $comment = $wgContLang->truncate( $comment, 255 );
1214 $this->lock(); // begin
1215 $status = $this->publish( $src, $flags, $options );
1217 if ( $status->successCount
>= 2 ) {
1218 // There will be a copy+(one of move,copy,store).
1219 // The first succeeding does not commit us to updating the DB
1220 // since it simply copied the current version to a timestamped file name.
1221 // It is only *preferable* to avoid leaving such files orphaned.
1222 // Once the second operation goes through, then the current version was
1223 // updated and we must therefore update the DB too.
1224 $oldver = $status->value
;
1225 if ( !$this->recordUpload2( $oldver, $comment, $pageText, $props, $timestamp, $user, $tags ) ) {
1226 $status->fatal( 'filenotfound', $srcPath );
1230 $this->unlock(); // done
1236 * Record a file upload in the upload log and the image table
1237 * @param string $oldver
1238 * @param string $desc
1239 * @param string $license
1240 * @param string $copyStatus
1241 * @param string $source
1242 * @param bool $watch
1243 * @param string|bool $timestamp
1244 * @param User|null $user User object or null to use $wgUser
1247 function recordUpload( $oldver, $desc, $license = '', $copyStatus = '', $source = '',
1248 $watch = false, $timestamp = false, User
$user = null ) {
1254 $pageText = SpecialUpload
::getInitialPageText( $desc, $license, $copyStatus, $source );
1256 if ( !$this->recordUpload2( $oldver, $desc, $pageText, false, $timestamp, $user ) ) {
1261 $user->addWatch( $this->getTitle() );
1268 * Record a file upload in the upload log and the image table
1269 * @param string $oldver
1270 * @param string $comment
1271 * @param string $pageText
1272 * @param bool|array $props
1273 * @param string|bool $timestamp
1274 * @param null|User $user
1275 * @param string[] $tags
1278 function recordUpload2(
1279 $oldver, $comment, $pageText, $props = false, $timestamp = false, $user = null, $tags = []
1281 if ( is_null( $user ) ) {
1286 $dbw = $this->repo
->getMasterDB();
1288 # Imports or such might force a certain timestamp; otherwise we generate
1289 # it and can fudge it slightly to keep (name,timestamp) unique on re-upload.
1290 if ( $timestamp === false ) {
1291 $timestamp = $dbw->timestamp();
1292 $allowTimeKludge = true;
1294 $allowTimeKludge = false;
1297 $props = $props ?
: $this->repo
->getFileProps( $this->getVirtualUrl() );
1298 $props['description'] = $comment;
1299 $props['user'] = $user->getId();
1300 $props['user_text'] = $user->getName();
1301 $props['timestamp'] = wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1302 $this->setProps( $props );
1304 # Fail now if the file isn't there
1305 if ( !$this->fileExists
) {
1306 wfDebug( __METHOD__
. ": File " . $this->getRel() . " went missing!\n" );
1311 $dbw->startAtomic( __METHOD__
);
1313 # Test to see if the row exists using INSERT IGNORE
1314 # This avoids race conditions by locking the row until the commit, and also
1315 # doesn't deadlock. SELECT FOR UPDATE causes a deadlock for every race condition.
1316 $dbw->insert( 'image',
1318 'img_name' => $this->getName(),
1319 'img_size' => $this->size
,
1320 'img_width' => intval( $this->width
),
1321 'img_height' => intval( $this->height
),
1322 'img_bits' => $this->bits
,
1323 'img_media_type' => $this->media_type
,
1324 'img_major_mime' => $this->major_mime
,
1325 'img_minor_mime' => $this->minor_mime
,
1326 'img_timestamp' => $timestamp,
1327 'img_description' => $comment,
1328 'img_user' => $user->getId(),
1329 'img_user_text' => $user->getName(),
1330 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1331 'img_sha1' => $this->sha1
1337 $reupload = ( $dbw->affectedRows() == 0 );
1339 if ( $allowTimeKludge ) {
1340 # Use LOCK IN SHARE MODE to ignore any transaction snapshotting
1341 $ltimestamp = $dbw->selectField(
1344 [ 'img_name' => $this->getName() ],
1346 [ 'LOCK IN SHARE MODE' ]
1348 $lUnixtime = $ltimestamp ?
wfTimestamp( TS_UNIX
, $ltimestamp ) : false;
1349 # Avoid a timestamp that is not newer than the last version
1350 # TODO: the image/oldimage tables should be like page/revision with an ID field
1351 if ( $lUnixtime && wfTimestamp( TS_UNIX
, $timestamp ) <= $lUnixtime ) {
1352 sleep( 1 ); // fast enough re-uploads would go far in the future otherwise
1353 $timestamp = $dbw->timestamp( $lUnixtime +
1 );
1354 $this->timestamp
= wfTimestamp( TS_MW
, $timestamp ); // DB -> TS_MW
1358 # (T36993) Note: $oldver can be empty here, if the previous
1359 # version of the file was broken. Allow registration of the new
1360 # version to continue anyway, because that's better than having
1361 # an image that's not fixable by user operations.
1362 # Collision, this is an update of a file
1363 # Insert previous contents into oldimage
1364 $dbw->insertSelect( 'oldimage', 'image',
1366 'oi_name' => 'img_name',
1367 'oi_archive_name' => $dbw->addQuotes( $oldver ),
1368 'oi_size' => 'img_size',
1369 'oi_width' => 'img_width',
1370 'oi_height' => 'img_height',
1371 'oi_bits' => 'img_bits',
1372 'oi_timestamp' => 'img_timestamp',
1373 'oi_description' => 'img_description',
1374 'oi_user' => 'img_user',
1375 'oi_user_text' => 'img_user_text',
1376 'oi_metadata' => 'img_metadata',
1377 'oi_media_type' => 'img_media_type',
1378 'oi_major_mime' => 'img_major_mime',
1379 'oi_minor_mime' => 'img_minor_mime',
1380 'oi_sha1' => 'img_sha1'
1382 [ 'img_name' => $this->getName() ],
1386 # Update the current image row
1387 $dbw->update( 'image',
1389 'img_size' => $this->size
,
1390 'img_width' => intval( $this->width
),
1391 'img_height' => intval( $this->height
),
1392 'img_bits' => $this->bits
,
1393 'img_media_type' => $this->media_type
,
1394 'img_major_mime' => $this->major_mime
,
1395 'img_minor_mime' => $this->minor_mime
,
1396 'img_timestamp' => $timestamp,
1397 'img_description' => $comment,
1398 'img_user' => $user->getId(),
1399 'img_user_text' => $user->getName(),
1400 'img_metadata' => $dbw->encodeBlob( $this->metadata
),
1401 'img_sha1' => $this->sha1
1403 [ 'img_name' => $this->getName() ],
1408 $descTitle = $this->getTitle();
1409 $descId = $descTitle->getArticleID();
1410 $wikiPage = new WikiFilePage( $descTitle );
1411 $wikiPage->setFile( $this );
1413 // Add the log entry...
1414 $logEntry = new ManualLogEntry( 'upload', $reupload ?
'overwrite' : 'upload' );
1415 $logEntry->setTimestamp( $this->timestamp
);
1416 $logEntry->setPerformer( $user );
1417 $logEntry->setComment( $comment );
1418 $logEntry->setTarget( $descTitle );
1419 // Allow people using the api to associate log entries with the upload.
1420 // Log has a timestamp, but sometimes different from upload timestamp.
1421 $logEntry->setParameters(
1423 'img_sha1' => $this->sha1
,
1424 'img_timestamp' => $timestamp,
1427 // Note we keep $logId around since during new image
1428 // creation, page doesn't exist yet, so log_page = 0
1429 // but we want it to point to the page we're making,
1430 // so we later modify the log entry.
1431 // For a similar reason, we avoid making an RC entry
1432 // now and wait until the page exists.
1433 $logId = $logEntry->insert();
1435 if ( $descTitle->exists() ) {
1436 // Use own context to get the action text in content language
1437 $formatter = LogFormatter
::newFromEntry( $logEntry );
1438 $formatter->setContext( RequestContext
::newExtraneousContext( $descTitle ) );
1439 $editSummary = $formatter->getPlainActionText();
1441 $nullRevision = Revision
::newNullRevision(
1448 if ( $nullRevision ) {
1449 $nullRevision->insertOn( $dbw );
1451 'NewRevisionFromEditComplete',
1452 [ $wikiPage, $nullRevision, $nullRevision->getParentId(), $user ]
1454 $wikiPage->updateRevisionOn( $dbw, $nullRevision );
1455 // Associate null revision id
1456 $logEntry->setAssociatedRevId( $nullRevision->getId() );
1459 $newPageContent = null;
1461 // Make the description page and RC log entry post-commit
1462 $newPageContent = ContentHandler
::makeContent( $pageText, $descTitle );
1465 # Defer purges, page creation, and link updates in case they error out.
1466 # The most important thing is that files and the DB registry stay synced.
1467 $dbw->endAtomic( __METHOD__
);
1469 # Do some cache purges after final commit so that:
1470 # a) Changes are more likely to be seen post-purge
1471 # b) They won't cause rollback of the log publish/update above
1472 DeferredUpdates
::addUpdate(
1473 new AutoCommitUpdate(
1477 $reupload, $wikiPage, $newPageContent, $comment, $user,
1478 $logEntry, $logId, $descId, $tags
1480 # Update memcache after the commit
1481 $this->invalidateCache();
1483 $updateLogPage = false;
1484 if ( $newPageContent ) {
1485 # New file page; create the description page.
1486 # There's already a log entry, so don't make a second RC entry
1487 # CDN and file cache for the description page are purged by doEditContent.
1488 $status = $wikiPage->doEditContent(
1491 EDIT_NEW | EDIT_SUPPRESS_RC
,
1496 if ( isset( $status->value
['revision'] ) ) {
1497 /** @var $rev Revision */
1498 $rev = $status->value
['revision'];
1499 // Associate new page revision id
1500 $logEntry->setAssociatedRevId( $rev->getId() );
1502 // This relies on the resetArticleID() call in WikiPage::insertOn(),
1503 // which is triggered on $descTitle by doEditContent() above.
1504 if ( isset( $status->value
['revision'] ) ) {
1505 /** @var $rev Revision */
1506 $rev = $status->value
['revision'];
1507 $updateLogPage = $rev->getPage();
1510 # Existing file page: invalidate description page cache
1511 $wikiPage->getTitle()->invalidateCache();
1512 $wikiPage->getTitle()->purgeSquid();
1513 # Allow the new file version to be patrolled from the page footer
1514 Article
::purgePatrolFooterCache( $descId );
1517 # Update associated rev id. This should be done by $logEntry->insert() earlier,
1518 # but setAssociatedRevId() wasn't called at that point yet...
1519 $logParams = $logEntry->getParameters();
1520 $logParams['associated_rev_id'] = $logEntry->getAssociatedRevId();
1521 $update = [ 'log_params' => LogEntryBase
::makeParamBlob( $logParams ) ];
1522 if ( $updateLogPage ) {
1523 # Also log page, in case where we just created it above
1524 $update['log_page'] = $updateLogPage;
1526 $this->getRepo()->getMasterDB()->update(
1529 [ 'log_id' => $logId ],
1532 $this->getRepo()->getMasterDB()->insert(
1535 'ls_field' => 'associated_rev_id',
1536 'ls_value' => $logEntry->getAssociatedRevId(),
1537 'ls_log_id' => $logId,
1542 # Add change tags, if any
1544 $logEntry->setTags( $tags );
1547 # Uploads can be patrolled
1548 $logEntry->setIsPatrollable( true );
1550 # Now that the log entry is up-to-date, make an RC entry.
1551 $logEntry->publish( $logId );
1553 # Run hook for other updates (typically more cache purging)
1554 Hooks
::run( 'FileUpload', [ $this, $reupload, !$newPageContent ] );
1557 # Delete old thumbnails
1558 $this->purgeThumbnails();
1559 # Remove the old file from the CDN cache
1560 DeferredUpdates
::addUpdate(
1561 new CdnCacheUpdate( [ $this->getUrl() ] ),
1562 DeferredUpdates
::PRESEND
1565 # Update backlink pages pointing to this title if created
1566 LinksUpdate
::queueRecursiveJobsForTable( $this->getTitle(), 'imagelinks' );
1569 $this->prerenderThumbnails();
1572 DeferredUpdates
::PRESEND
1576 # This is a new file, so update the image count
1577 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
1580 # Invalidate cache for all pages using this file
1581 DeferredUpdates
::addUpdate( new HTMLCacheUpdate( $this->getTitle(), 'imagelinks' ) );
1587 * Move or copy a file to its public location. If a file exists at the
1588 * destination, move it to an archive. Returns a Status object with
1589 * the archive name in the "value" member on success.
1591 * The archive name should be passed through to recordUpload for database
1594 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1595 * @param int $flags A bitwise combination of:
1596 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1597 * @param array $options Optional additional parameters
1598 * @return Status On success, the value member contains the
1599 * archive name, or an empty string if it was a new file.
1601 function publish( $src, $flags = 0, array $options = [] ) {
1602 return $this->publishTo( $src, $this->getRel(), $flags, $options );
1606 * Move or copy a file to a specified location. Returns a Status
1607 * object with the archive name in the "value" member on success.
1609 * The archive name should be passed through to recordUpload for database
1612 * @param string|FSFile $src Local filesystem path or virtual URL to the source image
1613 * @param string $dstRel Target relative path
1614 * @param int $flags A bitwise combination of:
1615 * File::DELETE_SOURCE Delete the source file, i.e. move rather than copy
1616 * @param array $options Optional additional parameters
1617 * @return Status On success, the value member contains the
1618 * archive name, or an empty string if it was a new file.
1620 function publishTo( $src, $dstRel, $flags = 0, array $options = [] ) {
1621 $srcPath = ( $src instanceof FSFile
) ?
$src->getPath() : $src;
1623 $repo = $this->getRepo();
1624 if ( $repo->getReadOnlyReason() !== false ) {
1625 return $this->readOnlyFatalStatus();
1628 $this->lock(); // begin
1630 $archiveName = wfTimestamp( TS_MW
) . '!' . $this->getName();
1631 $archiveRel = 'archive/' . $this->getHashPath() . $archiveName;
1633 if ( $repo->hasSha1Storage() ) {
1634 $sha1 = $repo->isVirtualUrl( $srcPath )
1635 ?
$repo->getFileSha1( $srcPath )
1636 : FSFile
::getSha1Base36FromPath( $srcPath );
1637 /** @var FileBackendDBRepoWrapper $wrapperBackend */
1638 $wrapperBackend = $repo->getBackend();
1639 $dst = $wrapperBackend->getPathForSHA1( $sha1 );
1640 $status = $repo->quickImport( $src, $dst );
1641 if ( $flags & File
::DELETE_SOURCE
) {
1645 if ( $this->exists() ) {
1646 $status->value
= $archiveName;
1649 $flags = $flags & File
::DELETE_SOURCE ? LocalRepo
::DELETE_SOURCE
: 0;
1650 $status = $repo->publish( $srcPath, $dstRel, $archiveRel, $flags, $options );
1652 if ( $status->value
== 'new' ) {
1653 $status->value
= '';
1655 $status->value
= $archiveName;
1659 $this->unlock(); // done
1664 /** getLinksTo inherited */
1665 /** getExifData inherited */
1666 /** isLocal inherited */
1667 /** wasDeleted inherited */
1670 * Move file to the new title
1672 * Move current, old version and all thumbnails
1673 * to the new filename. Old file is deleted.
1675 * Cache purging is done; checks for validity
1676 * and logging are caller's responsibility
1678 * @param Title $target New file name
1681 function move( $target ) {
1682 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1683 return $this->readOnlyFatalStatus();
1686 wfDebugLog( 'imagemove', "Got request to move {$this->name} to " . $target->getText() );
1687 $batch = new LocalFileMoveBatch( $this, $target );
1689 $this->lock(); // begin
1690 $batch->addCurrent();
1691 $archiveNames = $batch->addOlds();
1692 $status = $batch->execute();
1693 $this->unlock(); // done
1695 wfDebugLog( 'imagemove', "Finished moving {$this->name}" );
1697 // Purge the source and target files...
1698 $oldTitleFile = wfLocalFile( $this->title
);
1699 $newTitleFile = wfLocalFile( $target );
1700 // To avoid slow purges in the transaction, move them outside...
1701 DeferredUpdates
::addUpdate(
1702 new AutoCommitUpdate(
1703 $this->getRepo()->getMasterDB(),
1705 function () use ( $oldTitleFile, $newTitleFile, $archiveNames ) {
1706 $oldTitleFile->purgeEverything();
1707 foreach ( $archiveNames as $archiveName ) {
1708 $oldTitleFile->purgeOldThumbnails( $archiveName );
1710 $newTitleFile->purgeEverything();
1713 DeferredUpdates
::PRESEND
1716 if ( $status->isOK() ) {
1717 // Now switch the object
1718 $this->title
= $target;
1719 // Force regeneration of the name and hashpath
1720 unset( $this->name
);
1721 unset( $this->hashPath
);
1728 * Delete all versions of the file.
1730 * Moves the files into an archive directory (or deletes them)
1731 * and removes the database rows.
1733 * Cache purging is done; logging is caller's responsibility.
1735 * @param string $reason
1736 * @param bool $suppress
1737 * @param User|null $user
1740 function delete( $reason, $suppress = false, $user = null ) {
1741 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1742 return $this->readOnlyFatalStatus();
1745 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1747 $this->lock(); // begin
1748 $batch->addCurrent();
1749 // Get old version relative paths
1750 $archiveNames = $batch->addOlds();
1751 $status = $batch->execute();
1752 $this->unlock(); // done
1754 if ( $status->isOK() ) {
1755 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => -1 ] ) );
1758 // To avoid slow purges in the transaction, move them outside...
1759 DeferredUpdates
::addUpdate(
1760 new AutoCommitUpdate(
1761 $this->getRepo()->getMasterDB(),
1763 function () use ( $archiveNames ) {
1764 $this->purgeEverything();
1765 foreach ( $archiveNames as $archiveName ) {
1766 $this->purgeOldThumbnails( $archiveName );
1770 DeferredUpdates
::PRESEND
1775 foreach ( $archiveNames as $archiveName ) {
1776 $purgeUrls[] = $this->getArchiveUrl( $archiveName );
1778 DeferredUpdates
::addUpdate( new CdnCacheUpdate( $purgeUrls ), DeferredUpdates
::PRESEND
);
1784 * Delete an old version of the file.
1786 * Moves the file into an archive directory (or deletes it)
1787 * and removes the database row.
1789 * Cache purging is done; logging is caller's responsibility.
1791 * @param string $archiveName
1792 * @param string $reason
1793 * @param bool $suppress
1794 * @param User|null $user
1795 * @throws MWException Exception on database or file store failure
1798 function deleteOld( $archiveName, $reason, $suppress = false, $user = null ) {
1799 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1800 return $this->readOnlyFatalStatus();
1803 $batch = new LocalFileDeleteBatch( $this, $reason, $suppress, $user );
1805 $this->lock(); // begin
1806 $batch->addOld( $archiveName );
1807 $status = $batch->execute();
1808 $this->unlock(); // done
1810 $this->purgeOldThumbnails( $archiveName );
1811 if ( $status->isOK() ) {
1812 $this->purgeDescription();
1815 DeferredUpdates
::addUpdate(
1816 new CdnCacheUpdate( [ $this->getArchiveUrl( $archiveName ) ] ),
1817 DeferredUpdates
::PRESEND
1824 * Restore all or specified deleted revisions to the given file.
1825 * Permissions and logging are left to the caller.
1827 * May throw database exceptions on error.
1829 * @param array $versions Set of record ids of deleted items to restore,
1830 * or empty to restore all revisions.
1831 * @param bool $unsuppress
1834 function restore( $versions = [], $unsuppress = false ) {
1835 if ( $this->getRepo()->getReadOnlyReason() !== false ) {
1836 return $this->readOnlyFatalStatus();
1839 $batch = new LocalFileRestoreBatch( $this, $unsuppress );
1841 $this->lock(); // begin
1845 $batch->addIds( $versions );
1847 $status = $batch->execute();
1848 if ( $status->isGood() ) {
1849 $cleanupStatus = $batch->cleanup();
1850 $cleanupStatus->successCount
= 0;
1851 $cleanupStatus->failCount
= 0;
1852 $status->merge( $cleanupStatus );
1854 $this->unlock(); // done
1859 /** isMultipage inherited */
1860 /** pageCount inherited */
1861 /** scaleHeight inherited */
1862 /** getImageSize inherited */
1865 * Get the URL of the file description page.
1868 function getDescriptionUrl() {
1869 return $this->title
->getLocalURL();
1873 * Get the HTML text of the description page
1874 * This is not used by ImagePage for local files, since (among other things)
1875 * it skips the parser cache.
1877 * @param Language $lang What language to get description in (Optional)
1878 * @return bool|mixed
1880 function getDescriptionText( $lang = null ) {
1881 $revision = Revision
::newFromTitle( $this->title
, false, Revision
::READ_NORMAL
);
1885 $content = $revision->getContent();
1889 $pout = $content->getParserOutput( $this->title
, null, new ParserOptions( null, $lang ) );
1891 return $pout->getText();
1895 * @param int $audience
1899 function getDescription( $audience = self
::FOR_PUBLIC
, User
$user = null ) {
1901 if ( $audience == self
::FOR_PUBLIC
&& $this->isDeleted( self
::DELETED_COMMENT
) ) {
1903 } elseif ( $audience == self
::FOR_THIS_USER
1904 && !$this->userCan( self
::DELETED_COMMENT
, $user )
1908 return $this->description
;
1913 * @return bool|string
1915 function getTimestamp() {
1918 return $this->timestamp
;
1922 * @return bool|string
1924 public function getDescriptionTouched() {
1925 // The DB lookup might return false, e.g. if the file was just deleted, or the shared DB repo
1926 // itself gets it from elsewhere. To avoid repeating the DB lookups in such a case, we
1927 // need to differentiate between null (uninitialized) and false (failed to load).
1928 if ( $this->descriptionTouched
=== null ) {
1930 'page_namespace' => $this->title
->getNamespace(),
1931 'page_title' => $this->title
->getDBkey()
1933 $touched = $this->repo
->getReplicaDB()->selectField( 'page', 'page_touched', $cond, __METHOD__
);
1934 $this->descriptionTouched
= $touched ?
wfTimestamp( TS_MW
, $touched ) : false;
1937 return $this->descriptionTouched
;
1943 function getSha1() {
1945 // Initialise now if necessary
1946 if ( $this->sha1
== '' && $this->fileExists
) {
1947 $this->lock(); // begin
1949 $this->sha1
= $this->repo
->getFileSha1( $this->getPath() );
1950 if ( !wfReadOnly() && strval( $this->sha1
) != '' ) {
1951 $dbw = $this->repo
->getMasterDB();
1952 $dbw->update( 'image',
1953 [ 'img_sha1' => $this->sha1
],
1954 [ 'img_name' => $this->getName() ],
1956 $this->invalidateCache();
1959 $this->unlock(); // done
1966 * @return bool Whether to cache in RepoGroup (this avoids OOMs)
1968 function isCacheable() {
1971 // If extra data (metadata) was not loaded then it must have been large
1972 return $this->extraDataLoaded
1973 && strlen( serialize( $this->metadata
) ) <= self
::CACHE_FIELD_MAX_LEN
;
1980 public function acquireFileLock() {
1981 return $this->getRepo()->getBackend()->lockFiles(
1982 [ $this->getPath() ], LockManager
::LOCK_EX
, 10
1990 public function releaseFileLock() {
1991 return $this->getRepo()->getBackend()->unlockFiles(
1992 [ $this->getPath() ], LockManager
::LOCK_EX
1997 * Start an atomic DB section and lock the image for update
1998 * or increments a reference counter if the lock is already held
2000 * This method should not be used outside of LocalFile/LocalFile*Batch
2002 * @throws LocalFileLockError Throws an error if the lock was not acquired
2003 * @return bool Whether the file lock owns/spawned the DB transaction
2005 public function lock() {
2006 if ( !$this->locked
) {
2007 $logger = LoggerFactory
::getInstance( 'LocalFile' );
2009 $dbw = $this->repo
->getMasterDB();
2010 $makesTransaction = !$dbw->trxLevel();
2011 $dbw->startAtomic( self
::ATOMIC_SECTION_LOCK
);
2012 // T56736: use simple lock to handle when the file does not exist.
2013 // SELECT FOR UPDATE prevents changes, not other SELECTs with FOR UPDATE.
2014 // Also, that would cause contention on INSERT of similarly named rows.
2015 $status = $this->acquireFileLock(); // represents all versions of the file
2016 if ( !$status->isGood() ) {
2017 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2018 $logger->warning( "Failed to lock '{file}'", [ 'file' => $this->name
] );
2020 throw new LocalFileLockError( $status );
2022 // Release the lock *after* commit to avoid row-level contention.
2023 // Make sure it triggers on rollback() as well as commit() (T132921).
2024 $dbw->onTransactionResolution(
2025 function () use ( $logger ) {
2026 $status = $this->releaseFileLock();
2027 if ( !$status->isGood() ) {
2028 $logger->error( "Failed to unlock '{file}'", [ 'file' => $this->name
] );
2033 // Callers might care if the SELECT snapshot is safely fresh
2034 $this->lockedOwnTrx
= $makesTransaction;
2039 return $this->lockedOwnTrx
;
2043 * Decrement the lock reference count and end the atomic section if it reaches zero
2045 * This method should not be used outside of LocalFile/LocalFile*Batch
2047 * The commit and loc release will happen when no atomic sections are active, which
2048 * may happen immediately or at some point after calling this
2050 public function unlock() {
2051 if ( $this->locked
) {
2053 if ( !$this->locked
) {
2054 $dbw = $this->repo
->getMasterDB();
2055 $dbw->endAtomic( self
::ATOMIC_SECTION_LOCK
);
2056 $this->lockedOwnTrx
= false;
2064 protected function readOnlyFatalStatus() {
2065 return $this->getRepo()->newFatal( 'filereadonlyerror', $this->getName(),
2066 $this->getRepo()->getName(), $this->getRepo()->getReadOnlyReason() );
2070 * Clean up any dangling locks
2072 function __destruct() {
2075 } // LocalFile class
2077 # ------------------------------------------------------------------------------
2080 * Helper class for file deletion
2081 * @ingroup FileAbstraction
2083 class LocalFileDeleteBatch
{
2084 /** @var LocalFile */
2091 private $srcRels = [];
2094 private $archiveUrls = [];
2096 /** @var array Items to be processed in the deletion batch */
2097 private $deletionBatch;
2099 /** @var bool Whether to suppress all suppressable fields when deleting */
2110 * @param string $reason
2111 * @param bool $suppress
2112 * @param User|null $user
2114 function __construct( File
$file, $reason = '', $suppress = false, $user = null ) {
2115 $this->file
= $file;
2116 $this->reason
= $reason;
2117 $this->suppress
= $suppress;
2119 $this->user
= $user;
2122 $this->user
= $wgUser;
2124 $this->status
= $file->repo
->newGood();
2127 public function addCurrent() {
2128 $this->srcRels
['.'] = $this->file
->getRel();
2132 * @param string $oldName
2134 public function addOld( $oldName ) {
2135 $this->srcRels
[$oldName] = $this->file
->getArchiveRel( $oldName );
2136 $this->archiveUrls
[] = $this->file
->getArchiveUrl( $oldName );
2140 * Add the old versions of the image to the batch
2141 * @return array List of archive names from old versions
2143 public function addOlds() {
2146 $dbw = $this->file
->repo
->getMasterDB();
2147 $result = $dbw->select( 'oldimage',
2148 [ 'oi_archive_name' ],
2149 [ 'oi_name' => $this->file
->getName() ],
2153 foreach ( $result as $row ) {
2154 $this->addOld( $row->oi_archive_name
);
2155 $archiveNames[] = $row->oi_archive_name
;
2158 return $archiveNames;
2164 protected function getOldRels() {
2165 if ( !isset( $this->srcRels
['.'] ) ) {
2166 $oldRels =& $this->srcRels
;
2167 $deleteCurrent = false;
2169 $oldRels = $this->srcRels
;
2170 unset( $oldRels['.'] );
2171 $deleteCurrent = true;
2174 return [ $oldRels, $deleteCurrent ];
2180 protected function getHashes() {
2182 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2184 if ( $deleteCurrent ) {
2185 $hashes['.'] = $this->file
->getSha1();
2188 if ( count( $oldRels ) ) {
2189 $dbw = $this->file
->repo
->getMasterDB();
2190 $res = $dbw->select(
2192 [ 'oi_archive_name', 'oi_sha1' ],
2193 [ 'oi_archive_name' => array_keys( $oldRels ),
2194 'oi_name' => $this->file
->getName() ], // performance
2198 foreach ( $res as $row ) {
2199 if ( rtrim( $row->oi_sha1
, "\0" ) === '' ) {
2200 // Get the hash from the file
2201 $oldUrl = $this->file
->getArchiveVirtualUrl( $row->oi_archive_name
);
2202 $props = $this->file
->repo
->getFileProps( $oldUrl );
2204 if ( $props['fileExists'] ) {
2205 // Upgrade the oldimage row
2206 $dbw->update( 'oldimage',
2207 [ 'oi_sha1' => $props['sha1'] ],
2208 [ 'oi_name' => $this->file
->getName(), 'oi_archive_name' => $row->oi_archive_name
],
2210 $hashes[$row->oi_archive_name
] = $props['sha1'];
2212 $hashes[$row->oi_archive_name
] = false;
2215 $hashes[$row->oi_archive_name
] = $row->oi_sha1
;
2220 $missing = array_diff_key( $this->srcRels
, $hashes );
2222 foreach ( $missing as $name => $rel ) {
2223 $this->status
->error( 'filedelete-old-unregistered', $name );
2226 foreach ( $hashes as $name => $hash ) {
2228 $this->status
->error( 'filedelete-missing', $this->srcRels
[$name] );
2229 unset( $hashes[$name] );
2236 protected function doDBInserts() {
2238 $dbw = $this->file
->repo
->getMasterDB();
2239 $encTimestamp = $dbw->addQuotes( $dbw->timestamp( $now ) );
2240 $encUserId = $dbw->addQuotes( $this->user
->getId() );
2241 $encReason = $dbw->addQuotes( $this->reason
);
2242 $encGroup = $dbw->addQuotes( 'deleted' );
2243 $ext = $this->file
->getExtension();
2244 $dotExt = $ext === '' ?
'' : ".$ext";
2245 $encExt = $dbw->addQuotes( $dotExt );
2246 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2248 // Bitfields to further suppress the content
2249 if ( $this->suppress
) {
2250 $bitfield = Revision
::SUPPRESSED_ALL
;
2252 $bitfield = 'oi_deleted';
2255 if ( $deleteCurrent ) {
2260 'fa_storage_group' => $encGroup,
2261 'fa_storage_key' => $dbw->conditional(
2262 [ 'img_sha1' => '' ],
2263 $dbw->addQuotes( '' ),
2264 $dbw->buildConcat( [ "img_sha1", $encExt ] )
2266 'fa_deleted_user' => $encUserId,
2267 'fa_deleted_timestamp' => $encTimestamp,
2268 'fa_deleted_reason' => $encReason,
2269 'fa_deleted' => $this->suppress ?
$bitfield : 0,
2270 'fa_name' => 'img_name',
2271 'fa_archive_name' => 'NULL',
2272 'fa_size' => 'img_size',
2273 'fa_width' => 'img_width',
2274 'fa_height' => 'img_height',
2275 'fa_metadata' => 'img_metadata',
2276 'fa_bits' => 'img_bits',
2277 'fa_media_type' => 'img_media_type',
2278 'fa_major_mime' => 'img_major_mime',
2279 'fa_minor_mime' => 'img_minor_mime',
2280 'fa_description' => 'img_description',
2281 'fa_user' => 'img_user',
2282 'fa_user_text' => 'img_user_text',
2283 'fa_timestamp' => 'img_timestamp',
2284 'fa_sha1' => 'img_sha1'
2286 [ 'img_name' => $this->file
->getName() ],
2291 if ( count( $oldRels ) ) {
2292 $res = $dbw->select(
2294 OldLocalFile
::selectFields(),
2296 'oi_name' => $this->file
->getName(),
2297 'oi_archive_name' => array_keys( $oldRels )
2303 foreach ( $res as $row ) {
2305 // Deletion-specific fields
2306 'fa_storage_group' => 'deleted',
2307 'fa_storage_key' => ( $row->oi_sha1
=== '' )
2309 : "{$row->oi_sha1}{$dotExt}",
2310 'fa_deleted_user' => $this->user
->getId(),
2311 'fa_deleted_timestamp' => $dbw->timestamp( $now ),
2312 'fa_deleted_reason' => $this->reason
,
2313 // Counterpart fields
2314 'fa_deleted' => $this->suppress ?
$bitfield : $row->oi_deleted
,
2315 'fa_name' => $row->oi_name
,
2316 'fa_archive_name' => $row->oi_archive_name
,
2317 'fa_size' => $row->oi_size
,
2318 'fa_width' => $row->oi_width
,
2319 'fa_height' => $row->oi_height
,
2320 'fa_metadata' => $row->oi_metadata
,
2321 'fa_bits' => $row->oi_bits
,
2322 'fa_media_type' => $row->oi_media_type
,
2323 'fa_major_mime' => $row->oi_major_mime
,
2324 'fa_minor_mime' => $row->oi_minor_mime
,
2325 'fa_description' => $row->oi_description
,
2326 'fa_user' => $row->oi_user
,
2327 'fa_user_text' => $row->oi_user_text
,
2328 'fa_timestamp' => $row->oi_timestamp
,
2329 'fa_sha1' => $row->oi_sha1
2333 $dbw->insert( 'filearchive', $rowsInsert, __METHOD__
);
2337 function doDBDeletes() {
2338 $dbw = $this->file
->repo
->getMasterDB();
2339 list( $oldRels, $deleteCurrent ) = $this->getOldRels();
2341 if ( count( $oldRels ) ) {
2342 $dbw->delete( 'oldimage',
2344 'oi_name' => $this->file
->getName(),
2345 'oi_archive_name' => array_keys( $oldRels )
2349 if ( $deleteCurrent ) {
2350 $dbw->delete( 'image', [ 'img_name' => $this->file
->getName() ], __METHOD__
);
2355 * Run the transaction
2358 public function execute() {
2359 $repo = $this->file
->getRepo();
2360 $this->file
->lock();
2362 // Prepare deletion batch
2363 $hashes = $this->getHashes();
2364 $this->deletionBatch
= [];
2365 $ext = $this->file
->getExtension();
2366 $dotExt = $ext === '' ?
'' : ".$ext";
2368 foreach ( $this->srcRels
as $name => $srcRel ) {
2369 // Skip files that have no hash (e.g. missing DB record, or sha1 field and file source)
2370 if ( isset( $hashes[$name] ) ) {
2371 $hash = $hashes[$name];
2372 $key = $hash . $dotExt;
2373 $dstRel = $repo->getDeletedHashPath( $key ) . $key;
2374 $this->deletionBatch
[$name] = [ $srcRel, $dstRel ];
2378 if ( !$repo->hasSha1Storage() ) {
2379 // Removes non-existent file from the batch, so we don't get errors.
2380 // This also handles files in the 'deleted' zone deleted via revision deletion.
2381 $checkStatus = $this->removeNonexistentFiles( $this->deletionBatch
);
2382 if ( !$checkStatus->isGood() ) {
2383 $this->status
->merge( $checkStatus );
2384 return $this->status
;
2386 $this->deletionBatch
= $checkStatus->value
;
2388 // Execute the file deletion batch
2389 $status = $this->file
->repo
->deleteBatch( $this->deletionBatch
);
2390 if ( !$status->isGood() ) {
2391 $this->status
->merge( $status );
2395 if ( !$this->status
->isOK() ) {
2396 // Critical file deletion error; abort
2397 $this->file
->unlock();
2399 return $this->status
;
2402 // Copy the image/oldimage rows to filearchive
2403 $this->doDBInserts();
2404 // Delete image/oldimage rows
2405 $this->doDBDeletes();
2407 // Commit and return
2408 $this->file
->unlock();
2410 return $this->status
;
2414 * Removes non-existent files from a deletion batch.
2415 * @param array $batch
2418 protected function removeNonexistentFiles( $batch ) {
2419 $files = $newBatch = [];
2421 foreach ( $batch as $batchItem ) {
2422 list( $src, ) = $batchItem;
2423 $files[$src] = $this->file
->repo
->getVirtualUrl( 'public' ) . '/' . rawurlencode( $src );
2426 $result = $this->file
->repo
->fileExistsBatch( $files );
2427 if ( in_array( null, $result, true ) ) {
2428 return Status
::newFatal( 'backend-fail-internal',
2429 $this->file
->repo
->getBackend()->getName() );
2432 foreach ( $batch as $batchItem ) {
2433 if ( $result[$batchItem[0]] ) {
2434 $newBatch[] = $batchItem;
2438 return Status
::newGood( $newBatch );
2442 # ------------------------------------------------------------------------------
2445 * Helper class for file undeletion
2446 * @ingroup FileAbstraction
2448 class LocalFileRestoreBatch
{
2449 /** @var LocalFile */
2452 /** @var array List of file IDs to restore */
2453 private $cleanupBatch;
2455 /** @var array List of file IDs to restore */
2458 /** @var bool Add all revisions of the file */
2461 /** @var bool Whether to remove all settings for suppressed fields */
2462 private $unsuppress = false;
2466 * @param bool $unsuppress
2468 function __construct( File
$file, $unsuppress = false ) {
2469 $this->file
= $file;
2470 $this->cleanupBatch
= $this->ids
= [];
2472 $this->unsuppress
= $unsuppress;
2479 public function addId( $fa_id ) {
2480 $this->ids
[] = $fa_id;
2484 * Add a whole lot of files by ID
2487 public function addIds( $ids ) {
2488 $this->ids
= array_merge( $this->ids
, $ids );
2492 * Add all revisions of the file
2494 public function addAll() {
2499 * Run the transaction, except the cleanup batch.
2500 * The cleanup batch should be run in a separate transaction, because it locks different
2501 * rows and there's no need to keep the image row locked while it's acquiring those locks
2502 * The caller may have its own transaction open.
2503 * So we save the batch and let the caller call cleanup()
2506 public function execute() {
2507 /** @var Language */
2510 $repo = $this->file
->getRepo();
2511 if ( !$this->all
&& !$this->ids
) {
2513 return $repo->newGood();
2516 $lockOwnsTrx = $this->file
->lock();
2518 $dbw = $this->file
->repo
->getMasterDB();
2519 $status = $this->file
->repo
->newGood();
2521 $exists = (bool)$dbw->selectField( 'image', '1',
2522 [ 'img_name' => $this->file
->getName() ],
2524 // The lock() should already prevents changes, but this still may need
2525 // to bypass any transaction snapshot. However, if lock() started the
2526 // trx (which it probably did) then snapshot is post-lock and up-to-date.
2527 $lockOwnsTrx ?
[] : [ 'LOCK IN SHARE MODE' ]
2530 // Fetch all or selected archived revisions for the file,
2531 // sorted from the most recent to the oldest.
2532 $conditions = [ 'fa_name' => $this->file
->getName() ];
2534 if ( !$this->all
) {
2535 $conditions['fa_id'] = $this->ids
;
2538 $result = $dbw->select(
2540 ArchivedFile
::selectFields(),
2543 [ 'ORDER BY' => 'fa_timestamp DESC' ]
2549 $insertCurrent = false;
2554 foreach ( $result as $row ) {
2555 $idsPresent[] = $row->fa_id
;
2557 if ( $row->fa_name
!= $this->file
->getName() ) {
2558 $status->error( 'undelete-filename-mismatch', $wgLang->timeanddate( $row->fa_timestamp
) );
2559 $status->failCount++
;
2563 if ( $row->fa_storage_key
== '' ) {
2564 // Revision was missing pre-deletion
2565 $status->error( 'undelete-bad-store-key', $wgLang->timeanddate( $row->fa_timestamp
) );
2566 $status->failCount++
;
2570 $deletedRel = $repo->getDeletedHashPath( $row->fa_storage_key
) .
2571 $row->fa_storage_key
;
2572 $deletedUrl = $repo->getVirtualUrl() . '/deleted/' . $deletedRel;
2574 if ( isset( $row->fa_sha1
) ) {
2575 $sha1 = $row->fa_sha1
;
2577 // old row, populate from key
2578 $sha1 = LocalRepo
::getHashFromKey( $row->fa_storage_key
);
2582 if ( strlen( $sha1 ) == 32 && $sha1[0] == '0' ) {
2583 $sha1 = substr( $sha1, 1 );
2586 if ( is_null( $row->fa_major_mime
) ||
$row->fa_major_mime
== 'unknown'
2587 ||
is_null( $row->fa_minor_mime
) ||
$row->fa_minor_mime
== 'unknown'
2588 ||
is_null( $row->fa_media_type
) ||
$row->fa_media_type
== 'UNKNOWN'
2589 ||
is_null( $row->fa_metadata
)
2591 // Refresh our metadata
2592 // Required for a new current revision; nice for older ones too. :)
2593 $props = RepoGroup
::singleton()->getFileProps( $deletedUrl );
2596 'minor_mime' => $row->fa_minor_mime
,
2597 'major_mime' => $row->fa_major_mime
,
2598 'media_type' => $row->fa_media_type
,
2599 'metadata' => $row->fa_metadata
2603 if ( $first && !$exists ) {
2604 // This revision will be published as the new current version
2605 $destRel = $this->file
->getRel();
2607 'img_name' => $row->fa_name
,
2608 'img_size' => $row->fa_size
,
2609 'img_width' => $row->fa_width
,
2610 'img_height' => $row->fa_height
,
2611 'img_metadata' => $props['metadata'],
2612 'img_bits' => $row->fa_bits
,
2613 'img_media_type' => $props['media_type'],
2614 'img_major_mime' => $props['major_mime'],
2615 'img_minor_mime' => $props['minor_mime'],
2616 'img_description' => $row->fa_description
,
2617 'img_user' => $row->fa_user
,
2618 'img_user_text' => $row->fa_user_text
,
2619 'img_timestamp' => $row->fa_timestamp
,
2623 // The live (current) version cannot be hidden!
2624 if ( !$this->unsuppress
&& $row->fa_deleted
) {
2625 $status->fatal( 'undeleterevdel' );
2626 $this->file
->unlock();
2630 $archiveName = $row->fa_archive_name
;
2632 if ( $archiveName == '' ) {
2633 // This was originally a current version; we
2634 // have to devise a new archive name for it.
2635 // Format is <timestamp of archiving>!<name>
2636 $timestamp = wfTimestamp( TS_UNIX
, $row->fa_deleted_timestamp
);
2639 $archiveName = wfTimestamp( TS_MW
, $timestamp ) . '!' . $row->fa_name
;
2641 } while ( isset( $archiveNames[$archiveName] ) );
2644 $archiveNames[$archiveName] = true;
2645 $destRel = $this->file
->getArchiveRel( $archiveName );
2647 'oi_name' => $row->fa_name
,
2648 'oi_archive_name' => $archiveName,
2649 'oi_size' => $row->fa_size
,
2650 'oi_width' => $row->fa_width
,
2651 'oi_height' => $row->fa_height
,
2652 'oi_bits' => $row->fa_bits
,
2653 'oi_description' => $row->fa_description
,
2654 'oi_user' => $row->fa_user
,
2655 'oi_user_text' => $row->fa_user_text
,
2656 'oi_timestamp' => $row->fa_timestamp
,
2657 'oi_metadata' => $props['metadata'],
2658 'oi_media_type' => $props['media_type'],
2659 'oi_major_mime' => $props['major_mime'],
2660 'oi_minor_mime' => $props['minor_mime'],
2661 'oi_deleted' => $this->unsuppress ?
0 : $row->fa_deleted
,
2662 'oi_sha1' => $sha1 ];
2665 $deleteIds[] = $row->fa_id
;
2667 if ( !$this->unsuppress
&& $row->fa_deleted
& File
::DELETED_FILE
) {
2668 // private files can stay where they are
2669 $status->successCount++
;
2671 $storeBatch[] = [ $deletedUrl, 'public', $destRel ];
2672 $this->cleanupBatch
[] = $row->fa_storage_key
;
2680 // Add a warning to the status object for missing IDs
2681 $missingIds = array_diff( $this->ids
, $idsPresent );
2683 foreach ( $missingIds as $id ) {
2684 $status->error( 'undelete-missing-filearchive', $id );
2687 if ( !$repo->hasSha1Storage() ) {
2688 // Remove missing files from batch, so we don't get errors when undeleting them
2689 $checkStatus = $this->removeNonexistentFiles( $storeBatch );
2690 if ( !$checkStatus->isGood() ) {
2691 $status->merge( $checkStatus );
2694 $storeBatch = $checkStatus->value
;
2696 // Run the store batch
2697 // Use the OVERWRITE_SAME flag to smooth over a common error
2698 $storeStatus = $this->file
->repo
->storeBatch( $storeBatch, FileRepo
::OVERWRITE_SAME
);
2699 $status->merge( $storeStatus );
2701 if ( !$status->isGood() ) {
2702 // Even if some files could be copied, fail entirely as that is the
2703 // easiest thing to do without data loss
2704 $this->cleanupFailedBatch( $storeStatus, $storeBatch );
2705 $status->setOK( false );
2706 $this->file
->unlock();
2712 // Run the DB updates
2713 // Because we have locked the image row, key conflicts should be rare.
2714 // If they do occur, we can roll back the transaction at this time with
2715 // no data loss, but leaving unregistered files scattered throughout the
2717 // This is not ideal, which is why it's important to lock the image row.
2718 if ( $insertCurrent ) {
2719 $dbw->insert( 'image', $insertCurrent, __METHOD__
);
2722 if ( $insertBatch ) {
2723 $dbw->insert( 'oldimage', $insertBatch, __METHOD__
);
2727 $dbw->delete( 'filearchive',
2728 [ 'fa_id' => $deleteIds ],
2732 // If store batch is empty (all files are missing), deletion is to be considered successful
2733 if ( $status->successCount
> 0 ||
!$storeBatch ||
$repo->hasSha1Storage() ) {
2735 wfDebug( __METHOD__
. " restored {$status->successCount} items, creating a new current\n" );
2737 DeferredUpdates
::addUpdate( SiteStatsUpdate
::factory( [ 'images' => 1 ] ) );
2739 $this->file
->purgeEverything();
2741 wfDebug( __METHOD__
. " restored {$status->successCount} as archived versions\n" );
2742 $this->file
->purgeDescription();
2746 $this->file
->unlock();
2752 * Removes non-existent files from a store batch.
2753 * @param array $triplets
2756 protected function removeNonexistentFiles( $triplets ) {
2757 $files = $filteredTriplets = [];
2758 foreach ( $triplets as $file ) {
2759 $files[$file[0]] = $file[0];
2762 $result = $this->file
->repo
->fileExistsBatch( $files );
2763 if ( in_array( null, $result, true ) ) {
2764 return Status
::newFatal( 'backend-fail-internal',
2765 $this->file
->repo
->getBackend()->getName() );
2768 foreach ( $triplets as $file ) {
2769 if ( $result[$file[0]] ) {
2770 $filteredTriplets[] = $file;
2774 return Status
::newGood( $filteredTriplets );
2778 * Removes non-existent files from a cleanup batch.
2779 * @param array $batch
2782 protected function removeNonexistentFromCleanup( $batch ) {
2783 $files = $newBatch = [];
2784 $repo = $this->file
->repo
;
2786 foreach ( $batch as $file ) {
2787 $files[$file] = $repo->getVirtualUrl( 'deleted' ) . '/' .
2788 rawurlencode( $repo->getDeletedHashPath( $file ) . $file );
2791 $result = $repo->fileExistsBatch( $files );
2793 foreach ( $batch as $file ) {
2794 if ( $result[$file] ) {
2795 $newBatch[] = $file;
2803 * Delete unused files in the deleted zone.
2804 * This should be called from outside the transaction in which execute() was called.
2807 public function cleanup() {
2808 if ( !$this->cleanupBatch
) {
2809 return $this->file
->repo
->newGood();
2812 $this->cleanupBatch
= $this->removeNonexistentFromCleanup( $this->cleanupBatch
);
2814 $status = $this->file
->repo
->cleanupDeletedBatch( $this->cleanupBatch
);
2820 * Cleanup a failed batch. The batch was only partially successful, so
2821 * rollback by removing all items that were succesfully copied.
2823 * @param Status $storeStatus
2824 * @param array $storeBatch
2826 protected function cleanupFailedBatch( $storeStatus, $storeBatch ) {
2829 foreach ( $storeStatus->success
as $i => $success ) {
2830 // Check if this item of the batch was successfully copied
2832 // Item was successfully copied and needs to be removed again
2833 // Extract ($dstZone, $dstRel) from the batch
2834 $cleanupBatch[] = [ $storeBatch[$i][1], $storeBatch[$i][2] ];
2837 $this->file
->repo
->cleanupBatch( $cleanupBatch );
2841 # ------------------------------------------------------------------------------
2844 * Helper class for file movement
2845 * @ingroup FileAbstraction
2847 class LocalFileMoveBatch
{
2848 /** @var LocalFile */
2858 protected $oldCount;
2862 /** @var IDatabase */
2867 * @param Title $target
2869 function __construct( File
$file, Title
$target ) {
2870 $this->file
= $file;
2871 $this->target
= $target;
2872 $this->oldHash
= $this->file
->repo
->getHashPath( $this->file
->getName() );
2873 $this->newHash
= $this->file
->repo
->getHashPath( $this->target
->getDBkey() );
2874 $this->oldName
= $this->file
->getName();
2875 $this->newName
= $this->file
->repo
->getNameFromTitle( $this->target
);
2876 $this->oldRel
= $this->oldHash
. $this->oldName
;
2877 $this->newRel
= $this->newHash
. $this->newName
;
2878 $this->db
= $file->getRepo()->getMasterDB();
2882 * Add the current image to the batch
2884 public function addCurrent() {
2885 $this->cur
= [ $this->oldRel
, $this->newRel
];
2889 * Add the old versions of the image to the batch
2890 * @return array List of archive names from old versions
2892 public function addOlds() {
2893 $archiveBase = 'archive';
2895 $this->oldCount
= 0;
2898 $result = $this->db
->select( 'oldimage',
2899 [ 'oi_archive_name', 'oi_deleted' ],
2900 [ 'oi_name' => $this->oldName
],
2902 [ 'LOCK IN SHARE MODE' ] // ignore snapshot
2905 foreach ( $result as $row ) {
2906 $archiveNames[] = $row->oi_archive_name
;
2907 $oldName = $row->oi_archive_name
;
2908 $bits = explode( '!', $oldName, 2 );
2910 if ( count( $bits ) != 2 ) {
2911 wfDebug( "Old file name missing !: '$oldName' \n" );
2915 list( $timestamp, $filename ) = $bits;
2917 if ( $this->oldName
!= $filename ) {
2918 wfDebug( "Old file name doesn't match: '$oldName' \n" );
2924 // Do we want to add those to oldCount?
2925 if ( $row->oi_deleted
& File
::DELETED_FILE
) {
2930 "{$archiveBase}/{$this->oldHash}{$oldName}",
2931 "{$archiveBase}/{$this->newHash}{$timestamp}!{$this->newName}"
2935 return $archiveNames;
2942 public function execute() {
2943 $repo = $this->file
->repo
;
2944 $status = $repo->newGood();
2945 $destFile = wfLocalFile( $this->target
);
2947 $this->file
->lock(); // begin
2948 $destFile->lock(); // quickly fail if destination is not available
2950 $triplets = $this->getMoveTriplets();
2951 $checkStatus = $this->removeNonexistentFiles( $triplets );
2952 if ( !$checkStatus->isGood() ) {
2953 $destFile->unlock();
2954 $this->file
->unlock();
2955 $status->merge( $checkStatus ); // couldn't talk to file backend
2958 $triplets = $checkStatus->value
;
2960 // Verify the file versions metadata in the DB.
2961 $statusDb = $this->verifyDBUpdates();
2962 if ( !$statusDb->isGood() ) {
2963 $destFile->unlock();
2964 $this->file
->unlock();
2965 $statusDb->setOK( false );
2970 if ( !$repo->hasSha1Storage() ) {
2971 // Copy the files into their new location.
2972 // If a prior process fataled copying or cleaning up files we tolerate any
2973 // of the existing files if they are identical to the ones being stored.
2974 $statusMove = $repo->storeBatch( $triplets, FileRepo
::OVERWRITE_SAME
);
2975 wfDebugLog( 'imagemove', "Moved files for {$this->file->getName()}: " .
2976 "{$statusMove->successCount} successes, {$statusMove->failCount} failures" );
2977 if ( !$statusMove->isGood() ) {
2978 // Delete any files copied over (while the destination is still locked)
2979 $this->cleanupTarget( $triplets );
2980 $destFile->unlock();
2981 $this->file
->unlock();
2982 wfDebugLog( 'imagemove', "Error in moving files: "
2983 . $statusMove->getWikiText( false, false, 'en' ) );
2984 $statusMove->setOK( false );
2988 $status->merge( $statusMove );
2991 // Rename the file versions metadata in the DB.
2992 $this->doDBUpdates();
2994 wfDebugLog( 'imagemove', "Renamed {$this->file->getName()} in database: " .
2995 "{$statusDb->successCount} successes, {$statusDb->failCount} failures" );
2997 $destFile->unlock();
2998 $this->file
->unlock(); // done
3000 // Everything went ok, remove the source files
3001 $this->cleanupSource( $triplets );
3003 $status->merge( $statusDb );
3009 * Verify the database updates and return a new Status indicating how
3010 * many rows would be updated.
3014 protected function verifyDBUpdates() {
3015 $repo = $this->file
->repo
;
3016 $status = $repo->newGood();
3019 $hasCurrent = $dbw->selectField(
3022 [ 'img_name' => $this->oldName
],
3026 $oldRowCount = $dbw->selectField(
3029 [ 'oi_name' => $this->oldName
],
3034 if ( $hasCurrent ) {
3035 $status->successCount++
;
3037 $status->failCount++
;
3039 $status->successCount +
= $oldRowCount;
3040 // T36934: oldCount is based on files that actually exist.
3041 // There may be more DB rows than such files, in which case $affected
3042 // can be greater than $total. We use max() to avoid negatives here.
3043 $status->failCount +
= max( 0, $this->oldCount
- $oldRowCount );
3044 if ( $status->failCount
) {
3045 $status->error( 'imageinvalidfilename' );
3052 * Do the database updates and return a new Status indicating how
3053 * many rows where updated.
3055 protected function doDBUpdates() {
3058 // Update current image
3061 [ 'img_name' => $this->newName
],
3062 [ 'img_name' => $this->oldName
],
3065 // Update old images
3069 'oi_name' => $this->newName
,
3070 'oi_archive_name = ' . $dbw->strreplace( 'oi_archive_name',
3071 $dbw->addQuotes( $this->oldName
), $dbw->addQuotes( $this->newName
) ),
3073 [ 'oi_name' => $this->oldName
],
3079 * Generate triplets for FileRepo::storeBatch().
3082 protected function getMoveTriplets() {
3083 $moves = array_merge( [ $this->cur
], $this->olds
);
3084 $triplets = []; // The format is: (srcUrl, destZone, destUrl)
3086 foreach ( $moves as $move ) {
3087 // $move: (oldRelativePath, newRelativePath)
3088 $srcUrl = $this->file
->repo
->getVirtualUrl() . '/public/' . rawurlencode( $move[0] );
3089 $triplets[] = [ $srcUrl, 'public', $move[1] ];
3092 "Generated move triplet for {$this->file->getName()}: {$srcUrl} :: public :: {$move[1]}"
3100 * Removes non-existent files from move batch.
3101 * @param array $triplets
3104 protected function removeNonexistentFiles( $triplets ) {
3107 foreach ( $triplets as $file ) {
3108 $files[$file[0]] = $file[0];
3111 $result = $this->file
->repo
->fileExistsBatch( $files );
3112 if ( in_array( null, $result, true ) ) {
3113 return Status
::newFatal( 'backend-fail-internal',
3114 $this->file
->repo
->getBackend()->getName() );
3117 $filteredTriplets = [];
3118 foreach ( $triplets as $file ) {
3119 if ( $result[$file[0]] ) {
3120 $filteredTriplets[] = $file;
3122 wfDebugLog( 'imagemove', "File {$file[0]} does not exist" );
3126 return Status
::newGood( $filteredTriplets );
3130 * Cleanup a partially moved array of triplets by deleting the target
3131 * files. Called if something went wrong half way.
3132 * @param array $triplets
3134 protected function cleanupTarget( $triplets ) {
3135 // Create dest pairs from the triplets
3137 foreach ( $triplets as $triplet ) {
3138 // $triplet: (old source virtual URL, dst zone, dest rel)
3139 $pairs[] = [ $triplet[1], $triplet[2] ];
3142 $this->file
->repo
->cleanupBatch( $pairs );
3146 * Cleanup a fully moved array of triplets by deleting the source files.
3147 * Called at the end of the move process if everything else went ok.
3148 * @param array $triplets
3150 protected function cleanupSource( $triplets ) {
3151 // Create source file names from the triplets
3153 foreach ( $triplets as $triplet ) {
3154 $files[] = $triplet[0];
3157 $this->file
->repo
->cleanupBatch( $files );
3161 class LocalFileLockError
extends ErrorPageError
{
3162 public function __construct( Status
$status ) {
3163 parent
::__construct(
3165 $status->getMessage()
3169 public function report() {
3171 $wgOut->setStatusCode( 429 );